<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>SecurityAllowedTestCase xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *    <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * KIND, either express or implied.  See the License for the</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a>  <em class="jxr_comment"> */</em> 
<a name="19" href="#19">19</a>   
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">package</strong> org.apache.commons.logging.security;
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.io.PrintWriter;
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.io.StringWriter;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> java.lang.reflect.Field;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> java.lang.reflect.Method;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> java.security.AllPermission;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> java.util.Hashtable;
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> junit.framework.Test;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> junit.framework.TestCase;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
<a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
<a name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.PathableClassLoader;
<a name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.PathableTestSuite;
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment">/**</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * Tests for logging with a security policy that allows JCL access to everything.</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * This class has only one unit test, as we are (in part) checking behaviour in</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * the static block of the LogFactory class. As that class cannot be unloaded after</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * being loaded into a classloader, the only workaround is to use the </em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * PathableClassLoader approach to ensure each test is run in its own</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * classloader, and use a separate testcase class for each test.</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> */</em>
<a name="46" href="#46">46</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/commons/logging/security/SecurityAllowedTestCase.html">SecurityAllowedTestCase</a> <strong class="jxr_keyword">extends</strong> TestCase
<a name="47" href="#47">47</a>  {
<a name="48" href="#48">48</a>      <strong class="jxr_keyword">private</strong> SecurityManager oldSecMgr;
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>      <em class="jxr_comment">// Dummy special hashtable, so we can tell JCL to use this instead of</em>
<a name="51" href="#51">51</a>      <em class="jxr_comment">// the standard one.</em>
<a name="52" href="#52">52</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/commons/logging/security/SecurityForbiddenTestCase.html">CustomHashtable</a> <strong class="jxr_keyword">extends</strong> Hashtable {
<a name="53" href="#53">53</a>      }
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>      <em class="jxr_javadoccomment">/**</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * Return the tests included in this test suite.</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     */</em>
<a name="58" href="#58">58</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Test suite() <strong class="jxr_keyword">throws</strong> Exception {
<a name="59" href="#59">59</a>          <a href="../../../../../org/apache/commons/logging/PathableClassLoader.html">PathableClassLoader</a> parent = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/logging/PathableClassLoader.html">PathableClassLoader</a>(<strong class="jxr_keyword">null</strong>);
<a name="60" href="#60">60</a>          parent.useExplicitLoader(<span class="jxr_string">"junit."</span>, Test.<strong class="jxr_keyword">class</strong>.getClassLoader());
<a name="61" href="#61">61</a>          parent.addLogicalLib(<span class="jxr_string">"commons-logging"</span>);
<a name="62" href="#62">62</a>          parent.addLogicalLib(<span class="jxr_string">"testclasses"</span>);
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>          Class testClass = parent.loadClass(
<a name="65" href="#65">65</a>              <span class="jxr_string">"org.apache.commons.logging.security.SecurityAllowedTestCase"</span>);
<a name="66" href="#66">66</a>          <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/logging/PathableTestSuite.html">PathableTestSuite</a>(testClass, parent);
<a name="67" href="#67">67</a>      }
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUp() {
<a name="70" href="#70">70</a>          <em class="jxr_comment">// save security manager so it can be restored in tearDown</em>
<a name="71" href="#71">71</a>          oldSecMgr = System.getSecurityManager();
<a name="72" href="#72">72</a>      }
<a name="73" href="#73">73</a>      
<a name="74" href="#74">74</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> tearDown() {
<a name="75" href="#75">75</a>          <em class="jxr_comment">// Restore, so other tests don't get stuffed up if a test</em>
<a name="76" href="#76">76</a>          <em class="jxr_comment">// sets a custom security manager.</em>
<a name="77" href="#77">77</a>          System.setSecurityManager(oldSecMgr);
<a name="78" href="#78">78</a>      }
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>      <em class="jxr_javadoccomment">/**</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * Test what happens when JCL is run with all permissions enabled. Custom</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * overrides should take effect.</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     */</em>
<a name="84" href="#84">84</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testAllAllowed() {
<a name="85" href="#85">85</a>          System.setProperty(
<a name="86" href="#86">86</a>                  LogFactory.HASHTABLE_IMPLEMENTATION_PROPERTY,
<a name="87" href="#87">87</a>                  CustomHashtable.<strong class="jxr_keyword">class</strong>.getName());
<a name="88" href="#88">88</a>          <a href="../../../../../org/apache/commons/logging/security/MockSecurityManager.html">MockSecurityManager</a> mySecurityManager = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/logging/security/MockSecurityManager.html">MockSecurityManager</a>();
<a name="89" href="#89">89</a>          mySecurityManager.addPermission(<strong class="jxr_keyword">new</strong> AllPermission());
<a name="90" href="#90">90</a>          System.setSecurityManager(mySecurityManager);
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>          <strong class="jxr_keyword">try</strong> {
<a name="93" href="#93">93</a>              <em class="jxr_comment">// Use reflection so that we can control exactly when the static</em>
<a name="94" href="#94">94</a>              <em class="jxr_comment">// initialiser for the LogFactory class is executed.</em>
<a name="95" href="#95">95</a>              Class c = <strong class="jxr_keyword">this</strong>.getClass().getClassLoader().loadClass(
<a name="96" href="#96">96</a>                      <span class="jxr_string">"org.apache.commons.logging.LogFactory"</span>);
<a name="97" href="#97">97</a>              Method m = c.getMethod(<span class="jxr_string">"getLog"</span>, <strong class="jxr_keyword">new</strong> Class[] {Class.<strong class="jxr_keyword">class</strong>});
<a name="98" href="#98">98</a>              Log log = (Log) m.invoke(<strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">new</strong> Object[] {<strong class="jxr_keyword">this</strong>.getClass()});
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>             <em class="jxr_comment">// Check whether we had any security exceptions so far (which were</em>
<a name="101" href="#101">101</a>             <em class="jxr_comment">// caught by the code). We should not, as every secure operation</em>
<a name="102" href="#102">102</a>             <em class="jxr_comment">// should be wrapped in an AccessController. Any security exceptions</em>
<a name="103" href="#103">103</a>             <em class="jxr_comment">// indicate a path that is missing an appropriate AccessController.</em>
<a name="104" href="#104">104</a>             <em class="jxr_comment">//</em>
<a name="105" href="#105">105</a>             <em class="jxr_comment">// We don't wait until after the log.info call to get this count</em>
<a name="106" href="#106">106</a>             <em class="jxr_comment">// because java.util.logging tries to load a resource bundle, which</em>
<a name="107" href="#107">107</a>             <em class="jxr_comment">// requires permission accessClassInPackage. JCL explicitly does not</em>
<a name="108" href="#108">108</a>             <em class="jxr_comment">// wrap calls to log methods in AccessControllers because writes to</em>
<a name="109" href="#109">109</a>             <em class="jxr_comment">// a log file *should* only be permitted if the original caller is</em>
<a name="110" href="#110">110</a>             <em class="jxr_comment">// trusted to access that file. </em>
<a name="111" href="#111">111</a>             <strong class="jxr_keyword">int</strong> untrustedCodeCount = mySecurityManager.getUntrustedCodeCount();
<a name="112" href="#112">112</a>             log.info(<span class="jxr_string">"testing"</span>);
<a name="113" href="#113">113</a>             
<a name="114" href="#114">114</a>             <em class="jxr_comment">// check that the default map implementation was loaded, as JCL was</em>
<a name="115" href="#115">115</a>             <em class="jxr_comment">// forbidden from reading the HASHTABLE_IMPLEMENTATION_PROPERTY property.</em>
<a name="116" href="#116">116</a>             System.setSecurityManager(<strong class="jxr_keyword">null</strong>);
<a name="117" href="#117">117</a>             Field factoryField = c.getDeclaredField(<span class="jxr_string">"factories"</span>);
<a name="118" href="#118">118</a>             factoryField.setAccessible(<strong class="jxr_keyword">true</strong>);
<a name="119" href="#119">119</a>             Object factoryTable = factoryField.get(<strong class="jxr_keyword">null</strong>); 
<a name="120" href="#120">120</a>             assertNotNull(factoryTable);
<a name="121" href="#121">121</a>             assertEquals(CustomHashtable.<strong class="jxr_keyword">class</strong>.getName(), factoryTable.getClass().getName());
<a name="122" href="#122">122</a>             
<a name="123" href="#123">123</a>             assertEquals(0, untrustedCodeCount);
<a name="124" href="#124">124</a>         } <strong class="jxr_keyword">catch</strong>(Throwable t) {
<a name="125" href="#125">125</a>             <em class="jxr_comment">// Restore original security manager so output can be generated; the</em>
<a name="126" href="#126">126</a>             <em class="jxr_comment">// PrintWriter constructor tries to read the line.separator</em>
<a name="127" href="#127">127</a>             <em class="jxr_comment">// system property.</em>
<a name="128" href="#128">128</a>             System.setSecurityManager(oldSecMgr);
<a name="129" href="#129">129</a>             StringWriter sw = <strong class="jxr_keyword">new</strong> StringWriter();
<a name="130" href="#130">130</a>             PrintWriter pw = <strong class="jxr_keyword">new</strong> PrintWriter(sw);
<a name="131" href="#131">131</a>             t.printStackTrace(pw);
<a name="132" href="#132">132</a>             fail(<span class="jxr_string">"Unexpected exception:"</span> + t.getMessage() + <span class="jxr_string">":"</span> + sw.toString());
<a name="133" href="#133">133</a>         }
<a name="134" href="#134">134</a>     }
<a name="135" href="#135">135</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

